12.6 终端绑定用户
请求参数
Path: /api/v1/device/assignUser
Method: POST
接口描述:
- 建立终端与用户之间的绑定关系,绑定后即为授信终端。
- 可以基于 externalId 或 mac地址 绑定终端,不允许同时传入 externalId 和 mac地址,否则报错。
- 基于 mac地址 绑定终端时,如果匹配到多条数据,则不会绑定,报错返回。
- 接口适用于 v2.2.9 及以上版本。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
根据 externalId 绑定
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
externalId | string | 必须 | 外部ID | ||
userName | string | 必须 | 用户名 | ||
userDirectoryName | string | 必须 | 用户目录名 | 用户所属用户目录的名称 |
请求示例
{
"externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7",
"userName": "张三",
"userDirectoryName": "本地用户目录"
}
根据 mac 绑定
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
mac | string | 必须 | MAC地址 | 匹配到多条终端时报错 | |
userName | string | 必须 | 用户名 | ||
userDirectoryName | string | 必须 | 用户目录名 | 用户所属用户目录的名称 |
请求示例
{
"mac": "FE-FC-FE-21-F5-D1",
"userName": "张三",
"userDirectoryName": "本地用户目录"
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示失败 | ||
data | object | 必须 | 响应数据 | ||
msg | string | 必须 | 描述信息 | ||
traceId | string | 必须 | 调用链ID,链路请求的标识 |
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功",
"traceId": "0022c672e4c8b0d6"
}
错误信息
错误提示 | 错误码 |
---|---|
MAC地址格式错误 | 7201 |
外部ID中不能含有非法的特殊字符:换行符,制表符,回车符 | 7201 |
外部ID长度超过最大上限:%d | 7201 |
请输入用户名 | 7201 |
请输入用户目录名称 | 7201 |
请输入匹配参数 | 10000001 |
请勿输入多个匹配参数: %s | 10000001 |
终端不存在 | 77200001 |
匹配到多条终端,请求失败 | 37400404 |
终端所属类型不支持绑定用户 | 37400409 |
用户不存在 | 77200001 |
授信终端已绑定成功,无需重复绑定 | 37400410 |
授信终端设置已开启终端与用户一对一绑定,请解除当前终端与其他用户的绑定关系后重试 | 37400411 |
当前用户的授信终端已达到数量上限:%d | 37400412 |